<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader Host: blfwk::ExcludesListMatcher Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kinetis Bootloader Host
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">Host Tools for Kinetis devices</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Introduction</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classblfwk_1_1_excludes_list_matcher.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classblfwk_1_1_excludes_list_matcher-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">blfwk::ExcludesListMatcher Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Matches strings using a series of include and exclude glob patterns.  
 <a href="classblfwk_1_1_excludes_list_matcher.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="src_2blfwk_2_excludes_list_matcher_8h_source.html">ExcludesListMatcher.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for blfwk::ExcludesListMatcher:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_excludes_list_matcher__inherit__graph.svg" width="192" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for blfwk::ExcludesListMatcher:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_excludes_list_matcher__coll__graph.svg" width="363" height="426"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_excludes_list_matcher.html#structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t">glob_list_item_t</a></td></tr>
<tr class="memdesc:structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Information about one glob pattern entry in a match list.  <a href="classblfwk_1_1_excludes_list_matcher.html#structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t">More...</a><br /></td></tr>
<tr class="separator:structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a860759de381aec4b801559e3d9a89e89"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a860759de381aec4b801559e3d9a89e89"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_excludes_list_matcher.html#a860759de381aec4b801559e3d9a89e89">ExcludesListMatcher</a> ()</td></tr>
<tr class="memdesc:a860759de381aec4b801559e3d9a89e89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a860759de381aec4b801559e3d9a89e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e0c855c5666662785a5400926f6ee9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e0c855c5666662785a5400926f6ee9c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_excludes_list_matcher.html#a7e0c855c5666662785a5400926f6ee9c">~ExcludesListMatcher</a> ()</td></tr>
<tr class="memdesc:a7e0c855c5666662785a5400926f6ee9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a7e0c855c5666662785a5400926f6ee9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a262053381ffc163cd3d4cecb2a5efa33"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_excludes_list_matcher.html#a262053381ffc163cd3d4cecb2a5efa33">match</a> (const std::string &amp;testValue)</td></tr>
<tr class="memdesc:a262053381ffc163cd3d4cecb2a5efa33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a single string match test against testValue.  <a href="#a262053381ffc163cd3d4cecb2a5efa33">More...</a><br /></td></tr>
<tr class="separator:a262053381ffc163cd3d4cecb2a5efa33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Pattern list</div></td></tr>
<tr class="memitem:a5b7379f234e988a6e771b59ddaa3b11b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_excludes_list_matcher.html#a5b7379f234e988a6e771b59ddaa3b11b">addPattern</a> (bool isInclude, const std::string &amp;pattern)</td></tr>
<tr class="memdesc:a5b7379f234e988a6e771b59ddaa3b11b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add one include or exclude pattern to the end of the match list.  <a href="#a5b7379f234e988a6e771b59ddaa3b11b">More...</a><br /></td></tr>
<tr class="separator:a5b7379f234e988a6e771b59ddaa3b11b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classblfwk_1_1_glob_matcher"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classblfwk_1_1_glob_matcher')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classblfwk_1_1_glob_matcher.html">blfwk::GlobMatcher</a></td></tr>
<tr class="memitem:a2b79bd9a72c831090e338970f7f4661b inherit pub_methods_classblfwk_1_1_glob_matcher"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b79bd9a72c831090e338970f7f4661b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_glob_matcher.html#a2b79bd9a72c831090e338970f7f4661b">GlobMatcher</a> (const std::string &amp;pattern)</td></tr>
<tr class="memdesc:a2b79bd9a72c831090e338970f7f4661b inherit pub_methods_classblfwk_1_1_glob_matcher"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a2b79bd9a72c831090e338970f7f4661b inherit pub_methods_classblfwk_1_1_glob_matcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:a5232cc35193dacd702850c4ada40281b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5232cc35193dacd702850c4ada40281b"></a>
typedef std::vector&lt; <a class="el" href="classblfwk_1_1_excludes_list_matcher.html#structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t">glob_list_item_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>glob_list_t</b></td></tr>
<tr class="separator:a5232cc35193dacd702850c4ada40281b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a896338d13c9ebb25bae83dae1b3de871"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a896338d13c9ebb25bae83dae1b3de871"></a>
glob_list_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_excludes_list_matcher.html#a896338d13c9ebb25bae83dae1b3de871">m_patterns</a></td></tr>
<tr class="memdesc:a896338d13c9ebb25bae83dae1b3de871"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ordered list of include and exclude patterns. <br /></td></tr>
<tr class="separator:a896338d13c9ebb25bae83dae1b3de871"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classblfwk_1_1_glob_matcher"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classblfwk_1_1_glob_matcher')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classblfwk_1_1_glob_matcher.html">blfwk::GlobMatcher</a></td></tr>
<tr class="memitem:a3876ebea9f4af5e8be2a76b8238dff98 inherit pro_attribs_classblfwk_1_1_glob_matcher"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3876ebea9f4af5e8be2a76b8238dff98"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_glob_matcher.html#a3876ebea9f4af5e8be2a76b8238dff98">m_pattern</a></td></tr>
<tr class="memdesc:a3876ebea9f4af5e8be2a76b8238dff98 inherit pro_attribs_classblfwk_1_1_glob_matcher"><td class="mdescLeft">&#160;</td><td class="mdescRight">The glob pattern to match against. <br /></td></tr>
<tr class="separator:a3876ebea9f4af5e8be2a76b8238dff98 inherit pro_attribs_classblfwk_1_1_glob_matcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classblfwk_1_1_glob_matcher"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classblfwk_1_1_glob_matcher')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classblfwk_1_1_glob_matcher.html">blfwk::GlobMatcher</a></td></tr>
<tr class="memitem:acee3e2a63d6ddf3eebc02c9136c50743 inherit pro_methods_classblfwk_1_1_glob_matcher"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_glob_matcher.html#acee3e2a63d6ddf3eebc02c9136c50743">globMatch</a> (const char *str, const char *p)</td></tr>
<tr class="memdesc:acee3e2a63d6ddf3eebc02c9136c50743 inherit pro_methods_classblfwk_1_1_glob_matcher"><td class="mdescLeft">&#160;</td><td class="mdescRight">Glob implementation.  <a href="#acee3e2a63d6ddf3eebc02c9136c50743">More...</a><br /></td></tr>
<tr class="separator:acee3e2a63d6ddf3eebc02c9136c50743 inherit pro_methods_classblfwk_1_1_glob_matcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Matches strings using a series of include and exclude glob patterns. </p>
<p>This string matcher class uses a sequential, ordered list of glob patterns to determine whether a string matches. Attached to each pattern is an include/exclude action. The patterns in the list effectively form a Boolean expression. Includes act as an OR operator while excludes act as an AND NOT operator.</p>
<p>Examples (plus prefix is include, minus prefix is exclude):</p><ul>
<li>+foo: foo</li>
<li>-foo: !foo</li>
<li>+foo, +bar: foo || bar</li>
<li>+foo, -bar: foo &amp;&amp; !bar</li>
<li>+foo, -bar, +baz: foo &amp;&amp; !bar || baz</li>
</ul>
<p>The only reason for inheriting from <a class="el" href="classblfwk_1_1_glob_matcher.html" title="This class uses glob pattern matching to match strings. ">GlobMatcher</a> is so we can access the protected <a class="el" href="classblfwk_1_1_glob_matcher.html#acee3e2a63d6ddf3eebc02c9136c50743" title="Glob implementation. ">globMatch()</a> method. </p>
</div><hr/><h2 class="groupheader">Class Documentation</h2>
<a name="structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t" id="structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct blfwk::ExcludesListMatcher::glob_list_item_t</td>
        </tr>
      </table>
</div><div class="memdoc">
<div class="textblock"><p>Information about one glob pattern entry in a match list. </p>
</div><div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-2-trigger" src="closed.png" alt="+"/> Collaboration diagram for blfwk::ExcludesListMatcher::glob_list_item_t:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="structblfwk_1_1_excludes_list_matcher_1_1glob__list__item__t__coll__graph.svg" width="192" height="232"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a49a6917854f8672c5a9963a34ffcf521"></a>string</td>
<td class="fieldname">
m_glob</td>
<td class="fielddoc">
The glob pattern to match. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac260e1de9d114325b9a5c34116622bbf"></a>bool</td>
<td class="fieldname">
m_isInclude</td>
<td class="fielddoc">
True if include, false if exclude. </td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5b7379f234e988a6e771b59ddaa3b11b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ExcludesListMatcher::addPattern </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isInclude</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>pattern</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add one include or exclude pattern to the end of the match list. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">isInclude</td><td>True if this pattern is an include, false if it is an exclude. </td></tr>
    <tr><td class="paramname">pattern</td><td>String containing the glob pattern. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a262053381ffc163cd3d4cecb2a5efa33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool ExcludesListMatcher::match </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>testValue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Performs a single string match test against testValue. </p>
<p>If there are no entries in the match list, the match fails.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">testValue</td><td>The string to match against the pattern list. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>The <em>testValue</em> argument matches. </td></tr>
    <tr><td class="paramname">false</td><td>No match was made against the argument. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classblfwk_1_1_glob_matcher.html#a5c2c9b8d4514b85ddea0267246b59ceb">blfwk::GlobMatcher</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="src_2blfwk_2_excludes_list_matcher_8h_source.html">src/blfwk/ExcludesListMatcher.h</a></li>
<li>src/blfwk/src/ExcludesListMatcher.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>blfwk</b></li><li class="navelem"><a class="el" href="classblfwk_1_1_excludes_list_matcher.html">ExcludesListMatcher</a></li>
    <li class="footer">Generated on Mon Mar 7 2016 16:49:51 for Kinetis Bootloader Host by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
